/*-----------------------------------------------------------------------------
	The contents of this file are subject to the Mozilla Public License
	Version 1.1 (the "License"); you may not use this file except in
	compliance with the License. You may obtain a copy of the License at
	http://www.mozilla.org/MPL/
	
	Software distributed under the License is distributed on an "AS IS"
	basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
	License for the specific language governing rights and limitations
	under the License.
	
	The Original Code is Fever Framework code.
	
	The Initial Developer of the Original Code is Romain Ecarnot.
	Portions created by Initial Developer are Copyright (C) 2006
	the Initial Developer. All Rights Reserved.
	
	Contributor(s):
	
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
-----------------------------------------------------------------------------*/

import com.bourre.events.EventType;

import fever.events.AbstractEvent;

/**
 * Event structure for internal MVC event flow.
 *
 * @author Romain Ecarnot
 */
class fvaswing.components.filechooser.events.FvFileChooserModelEvent extends AbstractEvent
{
	//-------------------------------------------------------------------------
	// Events definition
	//-------------------------------------------------------------------------
	
	public static var UPDATE : EventType = new EventType( "onListUpdate" );	public static var ERROR : EventType = new EventType( "onListError" );
	
		
	//-------------------------------------------------------------------------
	// Private properties
	//-------------------------------------------------------------------------
	
	private var _current : String;
	private var _list : Array;	private var _cache : Array;
	private var _success : Boolean;
	
	
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
		
	/**
	 * Constructor.
	 */
	public function FvFileChooserModelEvent( e : EventType, currentPath : String, fileList : Array, cacheList : Array )
	{
		super( e );
		
		_success = true;
		_current = currentPath;
		_list = fileList;
		_cache = cacheList;
	}
	
	/**
	 * Defines if process has finished successfully or not.
	 */
	public function setSuccess( b : Boolean ) : Void
	{
		_success = b;
	}
	
	/**
	 * Indicates event success. 
	 */
	public function isSuccess() : Boolean
	{
		return _success;	
	}
	
	/**
	 * Returns current looked path
	 */
	public function getCurrentPath() : String
	{
		return _current;	
	}
	
	/**
	 * Returns the entire files list
	 */
	public function getFileList() : Array
	{
		return _list;	
	}
	
	/**
	 * Returns cache'id list used for combobox 'lookin'
	 */
	public function getCacheList() : Array
	{
		return _cache;	
	}
}